Dokumentacja

Parametry

Opisy parametrów na poziomie strony

Te parametry trzeba określać tylko raz na stronie. Wpływają one na wszystkie jednostki na stronie.

Wymagane

Parametr Opis i przykłady
adPage Wymagane, gdy użytkownik przejdzie na następną lub poprzednią stronę wyników wyszukiwania.

Parametr adPage określa, na której stronie wyników wyświetlają się reklamy. Jest on używany, gdy użytkownicy przechodzą poza pierwszą stronę wyników wyszukiwania. Jeśli np. zostanie zażądanych 5 reklam, a parametr adPage ma wartość 2, reklamy będą wyświetlane na drugiej stronie wyników wyszukiwania.

pubId Wymagany
Jest to Twój identyfikator klienta AdSense. Identyfikator „pubId” to część identyfikatora klienta, która następuje po „partner-”. Jeśli na przykład identyfikator klienta to „partner-test-property”, identyfikator pubId to „test-property”. Jest to standardowy protokół reklam w wyszukiwarce niestandardowej.

Przykład:

'pubId' : 'test-property'

query Wymagane z wyjątkiem podobnych wyszukiwań na stronach z treścią.
Jest to zapytanie wpisane przez użytkownika. Wartość parametru zapytania powinna być odkodowana.

Uwaga: użycie tego parametru w przypadku podobnych wyszukiwań na stronach z treścią może spowodować nieoczekiwane wyniki.

Przykłady:

'query' : 'flowers'
'query' : 'black & decker'
'query' : myQuery // myQuery is a variable containing the search query

resultsPageBaseUrl Wymagany, jeśli na stronie znajdują się jednostki podobnego wyszukiwania.
Określa adres URL strony wyników wyszukiwania, na której zapytanie jest podobnym wyszukiwanym hasłem klikniętym przez użytkownika. Element resultsPageBaseUrl może zawierać własne parametry z wyjątkiem zapytania, które jest dołączane automatycznie.

Przykład:

'resultsPageBaseUrl' : 'http://www.example.com/search?a=v1&b=v2'

styleId Wymagany
Określa identyfikator stylu reklamy w wyszukiwarce niestandardowej, który ma być stosowany do jednostek reklamowych lub jednostek podobnego wyszukiwania na stronie. Więcej informacji o korzystaniu z niestandardowych stylów reklamy w wyszukiwarce Pamiętaj, że gdy w żądaniu podasz parametr styleId, reklamy i podobne wyszukiwania będą renderowane z użyciem tego stylu, a starsze parametry stylu będą ignorowane. Jeśli w żądaniu nie określisz parametru styleId, zostanie wyrenderowany domyślny styl systemu.

Przykład:

'styleId': '1234567890'

Opcjonalnie

Parametr Opis i przykłady
linkTarget Opcjonalny
Określa, czy kliknięcie reklamy ma otwierać się w tym samym czy nowym oknie. Wartość domyślna to „_top”. Tego parametru możesz też używać na poziomie jednostki.
  • '_top' – strona otwiera się w tym samym oknie.
  • '_blank' – strona otwiera się w nowym oknie.

Przykład:

'linkTarget' : '_blank'

maxTermLength Opcjonalny
Określa maksymalną liczbę znaków (ze spacjami) podobnego wyszukiwanego hasła. Brak wartości maksymalnej, jeśli jej nie ustawiono.

Przykład:

'maxTermLength' : 50

referrerAdCreative Opcjonalny
Jeśli użytkownik trafia na stronę z treścią zawierającą jednostkę podobnego wyszukiwania dla treści po kliknięciu reklamy lub linku w innej witrynie, a Ty masz kontrolę nad tą reklamą lub tym linkiem, w tym parametrze należy podać dosłowny tekst kreacji tej reklamy lub linku.

Stosowanie tego parametru podlega tym wytycznym:

  • Ten parametr należy podawać tylko w odpowiedzi na żądanie dotyczące podobnego wyszukiwania na stronach z treścią. W przypadku pozostałych żądań będzie on ignorowany.
  • Należy go używać tylko w przypadku ruchu celowo pozyskiwanego z innych witryn. Nie należy korzystać z niego w przypadku ruchu bezpłatnego.
  • Powinien zawierać wiersz tytułu lub opis kreacji z linkiem lub reklamą.
  • Podawanie wartości, które nie należą do reklamy ani kreacji z linkiem, jest uważane za naruszenie tych pisemnych instrukcji.
  • Wielkość liter nie jest rozróżniana.
  • Akceptuje prawidłowe kodowanie UTF-8. Obsługiwane są znaki Unicode i diakrytyczne.
  • Google może wykorzystać przesłany przez Ciebie parametr lub go zignorować. Jeśli zostanie użyty, może mieć wpływ na wybór haseł i ich pozycję w rankingu.

Uwaga: ten parametr jest wymagany przy korzystaniu z parametru terms.

Przykłady:

'referrerAdCreative': 'search for ads related to dental implants'

'referrerAdCreative': 'The Early Signs of Psoriatic Arthritis'

resultsPageQueryParam Opcjonalny
Określa nazwę parametru adresu URL w przypadku wyszukiwanego hasła na stronie wyników wyszukiwania. Jeśli nie zostanie podany, domyślnie przyjmuje się „q”.

Przykład:

'resultsPageQueryParam' : 'query'

terms Opcjonalny
Ten parametr umożliwia podanie listy rozdzielonych przecinkami własnych podobnych wyszukiwanych haseł, które mają być zwracane w przypadku żądania podobnego wyszukiwania. Google może używać podanych tu terminów, ale nie musi.

Uwaga: gdy używasz tego parametru, wymagany jest też referrerAdCreative.

Przykłady:

'terms' : 'cars rental, flight ticket'

ignoredPageParams Opcjonalny
Określa listę parametrów adresu URL strony z treścią z jednostką podobnego wyszukiwania dla treści, które można bezpiecznie zignorować bez wpływu na główną treść lub wygodę użytkowników.

Uwaga: usługa podobnego wyszukiwania w treści korzysta z systemu indeksowania treści Google do indeksowania stron i generowania odpowiednich wyszukiwanych słów. Adresy URL stron z treścią zawierające parametry zapytania, np. zmienne śledzenia, identyfikatory użytkowników, identyfikatory sesji lub inne identyfikatory dynamiczne, mogą utrudniać robotowi ocenę głównej treści strony i prowadzić do wyświetlania nieprawidłowych lub nietrafnych podobnych wyszukiwanych haseł. Parametr strony informuje robota Google, że powinien zignorować te zbędne parametry, co zapewnia prawidłowe indeksowanie treści i zmniejsza niepotrzebne obciążenie indeksowaniem. Dzięki temu będziemy mogli lepiej rozpoznać, że strona została już zindeksowana, i zacząć wyświetlać sugerowane hasła (zarówno Google, jak i partnera, jeśli się kwalifikują).

Stosowanie tego parametru podlega tym wytycznym:

  • Ten parametr należy podawać tylko w odpowiedzi na żądanie dotyczące podobnego wyszukiwania na stronach z treścią. W przypadku pozostałych żądań będzie on ignorowany.
  • Wartość tego parametru powinna być rozdzielaną przecinkami listą parametrów adresu URL, które mogą pojawiać się, gdy dowolny użytkownik przejdzie na stronę treści.
  • Wielkość liter ma znaczenie.
  • Usunięcie z adresu URL strony z treścią dowolnego parametru adresu URL z tej listy nie powinno mieć znaczącego wpływu na zawartość, wygląd ani wrażenia użytkowników.
  • Uwzględnienie parametru adresu URL, który ma znaczny wpływ na treść, wygląd lub wrażenia użytkownika strony, jest uważane za naruszenie tych pisemnych instrukcji.
  • Google może okresowo weryfikować skutki zignorowania podanych parametrów adresu URL.

Przykłady:
Użytkownik odwiedza stronę z treścią, której adres URL to:

http://example.com/content?utm_medium=social&page_id=123&click_id=456
Podanie tych niemożliwych do pominięcia parametrów adresu URL:
'ignoredPageParams' : 'utm_medium,click_id,session_ref'
Adres URL strony z treścią zostanie potraktowany jako:
http://example.com/content?page_id=123

Ustawienia konfiguracji

Parametr Opis i przykłady
adsafe Opcjonalny
Określa reguły filtrowania, które Google ma zastosować do reklam pasujących do wyszukiwanego hasła. Oto prawidłowe ustawienia adsafe i wpływ każdej wartości na wyświetlane reklamy:
  • 'high' Zwraca reklamy dla całej rodziny. Nie wyświetla reklam nie dla całej rodziny lub zawierających treści erotyczne.
  • 'medium' Zwraca reklamy dla całej rodziny i nie dla całej rodziny. Nie wyświetla reklam zawierających treści erotyczne.
  • 'low' Zwraca wszystkie typy reklam.

Domyślnie wartość adsafe jest ustawiona na wysoki.

Przykład:

'adsafe': 'medium'

adtest Opcjonalny
Parametr adtest służy do wskazywania, że żądanie reklam ma charakter testowy. Gdy parametr adtest ma wartość on, Google traktuje żądanie jako test i nie zlicza wyświetleń reklamy ani nie śledzi wyników klikalności.

Gdy parametr adtest ma wartość on, nie uzyskujesz żadnych przychodów.

Używaj tego parametru podczas testowania. Nie używaj go w systemach produkcyjnych, ponieważ nie otrzymasz zapłaty za wyświetlane reklamy.

Wartość domyślna parametru adtest jest wyłączona.

Przykład:

'adtest' : 'on'

channel Opcjonalny
Aby śledzić skuteczność różnych stron, możesz dodać kanał AdSense dla wyszukiwania. Użyj unikalnego identyfikatora kanału, który został utworzony na koncie AdSense lub przez technicznego menedżera konta. Więcej informacji o kanałach znajdziesz tutaj.

Kilka kanałów powinno być rozdzielonych znakiem „+”.

Przykłady:

'channel' :  'testA'  
'channel' :  'testA+testB'  

hl Opcjonalny
Ten parametr określa język, na który mają być kierowane żądane reklamy lub podobne wyszukiwania. Wartością domyślną jest en.

Google obsługuje wszystkie kody języków interfejsu API AdWords.

Uwaga: języki, na jakie są kierowane reklamy, określają reklamodawcy. Jeśli umieścisz ten parametr w swoim żądaniu, Google będzie zwracać tylko reklamy kierowane na ten język lub na wszystkie języki, ale nie ma gwarancji, że tekst reklamy będzie zapisany w wybranym języku.

Zazwyczaj należy ustawić parametr hl na główny język strony, z której wysyłany jest ten parametr.

Przykłady:

'hl' : 'es'

ie Opcjonalny

Parametr ie określa schemat kodowania znaków, który powinien być używany do interpretacji ciągu zapytania.

Domyślną wartością parametru ie jest utf-8.

Wartość Nazwa standardowa Powiązane obsługiwane języki
latin1 ISO-8859-1 zachodnioeuropejskie (angielski, duński, fiński, francuski, hiszpański, indonezyjski, kataloński, niderlandzki, niemiecki, norweski, portugalski, szwedzki, włoski)
latin2 ISO-8859-2 wschodnioeuropejskie (chorwacki, czeski, polski, rumuński, serbski, słowacki, słoweński, węgierski)
latin3 ISO-8859-3  
latin4 ISO-8859-4 bałtycki (estoński, litewski, łotewski)
cyrylica ISO-8859-5 bułgarski, rosyjski
arabski ISO-8859-6  
grecki ISO-8859-7 grecki
hebrajski ISO-8859-8 hebrajski;
latin5 ISO-8859-9  
latin6 ISO-8859-10 islandzki
euc-jp EUC-JP japoński
Euc-kr EUC-KR koreański
Sisis Shift_JIS japoński
big5 Big5 chiński tradycyjny
gb GB2312 chiński uproszczony
utf-8 UTF-8 Wszystko
oe Opcjonalny

Parametr oe określa schemat kodowania znaków, którego Google ma użyć do kodowania tekstu reklam. Chociaż jest to opcjonalne, warto przekazać wartość dla tego parametru.

Domyślną wartością parametru oe jest utf-8.

Wartość Nazwa standardowa Powiązane obsługiwane języki
latin1 ISO-8859-1 zachodnioeuropejskie (angielski, duński, fiński, francuski, hiszpański, indonezyjski, kataloński, niderlandzki, niemiecki, norweski, portugalski, szwedzki, włoski)
latin2 ISO-8859-2 wschodnioeuropejskie (chorwacki, czeski, polski, rumuński, serbski, słowacki, słoweński, węgierski)
latin3 ISO-8859-3  
latin4 ISO-8859-4 bałtycki (estoński, litewski, łotewski)
cyrylica ISO-8859-5 bułgarski, rosyjski
arabski ISO-8859-6  
grecki ISO-8859-7 grecki
hebrajski ISO-8859-8 hebrajski;
latin5 ISO-8859-9  
latin6 ISO-8859-10 islandzki
euc-jp EUC-JP japoński
Euc-kr EUC-KR koreański
Sisis Shift_JIS japoński
gb GB2312 chiński uproszczony
utf-8 UTF-8 Wszystko
ivt Opcjonalny
Ten parametr umożliwia podanie wartości logicznej, która informuje Google, że chcesz zezwolić na wyświetlanie reklam korzystających z plików cookie służących tylko do wykrywania nieprawidłowego ruchu lub związanych z pamięcią lokalną zarówno w przypadku użytkowników, którzy wyrazili zgodę, jak i tych użytkowników.
  • true Jeśli ten parametr jest niedostępny lub ma on wartość „true”, ustawimy plik cookie służący tylko do wykrywania nieprawidłowego ruchu i będziemy używać pamięci lokalnej tylko w przypadku ruchu, w przypadku którego użytkownicy wyrazili zgodę.
  • false Jeśli ustawisz dla tego parametru wartość „false”, ustawimy plik cookie służący tylko do wykrywania nieprawidłowego ruchu i będziemy używać pamięci lokalnej zarówno w przypadku ruchu użytkowników, którzy wyrazili zgodę, jak i tych, którzy nie wyrazili zgody.

Domyślnie nieprawidłowy ruch ma wartość Prawda.

Przykład:

'ivt': false

Opis parametrów na poziomie jednostki

Te parametry wpływają na sposób wyświetlania użytkownikowi poszczególnych jednostek reklamowych na stronie. Każdy parametr można ustawiać osobno dla każdej jednostki reklamowej.

Wymagane

Parametr Opis i przykłady
container Wymagany
Identyfikator pustego kontenera <div>, w którym powinna pojawić się reklama.

Przykład:

'container' : 'afscontainer1'

maxTop Wymagany, gdy jednostka reklamowa wyświetla się nad wynikami wyszukiwania.

Ten parametr służy do określania liczby reklam wyświetlanych w górnej jednostce reklamowej.

Uwaga: ten parametr jest używany zamiast parametru „number”. Powinna ona być na tyle szeroka, by pierwszy wiersz reklam się nie zawijał. Używanie parametru maxTop w innym miejscu na stronie jest naruszeniem zasad.

Przykład:

'maxTop' : 4
width Wymagany
Określa szerokość reklamy lub jednostki podobnego wyszukiwania w pikselach.

Przykład:

'width' : '700px'
'width' : 700

Ustawienia konfiguracji

Parametr Opis i przykłady
adLoadedCallback Opcjonalny
Wskazuje funkcję JavaScriptu, która ma być wywoływana, gdy zostaną wczytane reklamy lub podobne wyszukiwania albo gdy nie wyświetlą się żadne reklamy ani podobne wyszukiwania. Powinien on być ustawiony na implementowaną przez Ciebie funkcję wywołania zwrotnego JavaScriptu, która umożliwia wykonanie działania po zakończeniu wywołania reklamy.

Funkcja wywołania zwrotnego przyjmuje te parametry:

containerName Nazwa kontenera jednostki reklamowej lub jednostki podobnego wyszukiwania.
adsLoaded Ustaw wartość „true”, jeśli istnieje co najmniej jedna reklama lub co najmniej jedno podobne wyszukiwane hasło do wyświetlenia, oraz „false”, jeśli nie zostały zwrócone żadne reklamy ani podobne wyszukiwania.
isExperimentVariant Ustaw wartość „true”, jeśli trwa eksperyment dotyczący stylu niestandardowego, a do wyrenderowania reklam zostanie wybrany jego wariant.
callbackOptions Obiekt JSON zawierający te pola:
termPositions: w przypadku bloku podobnego wyszukiwania zawiera w odpowiedzi atrybut map<string,int> z hasłami podanymi przez wydawcę w miejscu ich braku w indeksie. Jeśli hasło zostało podane, ale nie zostało zwrócone, nie pojawi się na mapie.

Uwaga: przetestuj funkcję wywołania zwrotnego, aby mieć pewność, że nie generuje ona żadnych błędów, zwłaszcza takich, które mogą zakłócać wczytywanie strony.

Przykład wywołania zwrotnego JavaScriptu:

var adblock1 = {
  'container' : 'adblock1_div_id',
  'adLoadedCallback' : function(containerName, adsLoaded,
    isExperimentVariant, callbackOptions) {
    if (adsLoaded) {
       try {
         // most likely do nothing
       } catch (e) {
         alert ("Error in callback function");
         // Do something to handle error gracefully
       }
    } else {
       // as you always do when there is no ad coverage from Google
    }
  }
};
      

number Opcjonalny
Liczba reklam, które powinny się wyświetlić w tej jednostce. Wartością domyślną jest 2.

Przykład:

'number' : 4

relatedSearches Opcjonalny
Liczba podobnych wyszukiwań, które powinny pojawić się w tej jednostce. Jeśli nie zostanie określona, przyjmuje domyślnie wartość 0.

Przykład:

'relatedSearches' : 4